10.6 Installing the MyID Client Service

The MyID Operator Client is a browser-based system that allows operators to work with people and requests in the MyID system; see the MyID Operator Client guide for details of using the client.

To allow the browser to access smart cards, capture images, issue soft certificates, print mailing documents, or access features of MyID Desktop or the Self-Service App, you must install the MyID Client Service on each Windows PC on which you want to use the MyID Operator Client.

The MyID Client Service installation program is located in the MyID release in the MyID Clients\MCS folder.

The installation program is provided as a .msi file that you can install directly or run from a command-line to install silently on each client PC.

Note: Intercede also provides MSIX versions of the installation programs for MyID Desktop, the Self-Service App, and the MyID Client Service. These are intended for an administrator to create an installation package that combines all of the necessary client software and administrator-controlled configuration. See the MyID Client MSIX Installation Guide for details of working with these installation programs.

Note: The MyID Client Service requires .NET Core; see section 4.3, Installing .NET Framework and .NET Core for details of how to obtain the correct version of .NET Core. Make sure this is installed before you attempt to install the MyID Client Service.

Important: The web services used by the MyID Operator Client (rest.core and web.oauth2) require SSL/TLS; if you do not connect through HTTPS, you cannot use the MyID Operator Client. For information on setting this up, see the Configuring SSL/TLS (HTTPS) section in the Securing Websites and Web Services document.

To install the MyID Client Service:

1. Copy the installation program to a local drive.

   If you do not run the installation program from a local drive, you may experience problems with the application running slowly due to certificate checks.

2. Run the installation program, then click Next.

3. Select the destination location, then click Next.

   By default, the MyID Client Service installs to the following folder:

   C:\Program Files (x86)\Intercede\

   Note: You do not need to have administrative privileges to install the MyID Client Service. However, you must make sure that you have the correct permissions to install software to the program folder; for example, your system administrator may not permit you to install software to the default folder. In this case, choose a different destination location.

4. Click Next.

5. In the Server URL box, type the location of the server on which the MyID web services are installed.

   For example:

   https://myserver

6. In the Access Control URL(s) box, type one or more URLs that point to websites that are permitted to access the MyID Client Service. Use commas to separate the URLs.

   For example:

   https://myserver,https://myserver2

7. Click Next.
8. Click Install.
9. When the installer has completed, click Finish.

To install silently on a client PC, you can use the .msi installer with the following command-line parameters:

msiexec /i "<msi path>" /lv <LogFile> /q REACT_SERVERNAME=<ServerURL> ACCESS_CONTROL_URLS=<accessurls> INSTALLDIR=<InstallationFolder>

where:

• <msi path> is the path to the .msi file.
• <LogFile> is the name of the file to which you want to write a verbose log. This is optional.
• <ServerURL> is the address of the MyID web services server; for example https://myserver/
• <accessurls> is a comma-delimited list of URLs of websites that are allowed to access the MyID Client Service.
• <InstallationFolder> is the name of the folder to which you want to install the application. This is optional.

Note: Do not put a space character on either side of the = signs in the command line.

For example:

msiexec /i "C:\install\MCS-1.x.x.x.msi" /lv msilog.txt /q REACT_SERVERNAME=https://myserver
ACCESS_CONTROL_URLS=https://myserver INSTALLDIR="C:\temp\desktop"

10.6.2 Running the MyID Client Service

The MyID Client Service must be running for the MyID Operator Client to use its capabilities to communicate with smart cards. You can run the MyID Client Service App from the Windows Start menu; however, as an administrator, you are recommended to set the MyIDClientService.exe application to run automatically at Windows logon.

When running, the MyID Client Service runs as an icon in the system tray. Right-click the icon and select one of the following options:

• Show – displays information about the service.

  

  The scrolling windows displays the most recent 1000 lines of log entries. This is displayed whether or not you have configured logging, but is not saved to a file. For details of configuring logging for the MyID Client Service, see the Windows clients section in the Configuring Logging guide.

  The following additional information is displayed:

  • Version – the version of the MyID Client Service that you are running.
  • API Version – This is the version of the MyID Web Service Architecture (MWS) to which the MyID Client Service is connected.

  • Language – the language that the MyID Client Service requests for its translations. If this is not available on the MyID server, it will use en-US.

    For information about translating the MyID interface, contact customer support quoting reference SUP-138.

  • Server – the server to which the MyID Client Service is connected.
  • Enable Access Control – Indicates whether or not access control is enabled. If it is disabled, the MyID Client Service will accept connections from any client origin rather than only from origins specified in the AccessControlAllowOrigin configuration.

  • Allowed Access Origins – the list of origins in the AccessControlAllowOrigin configuration from which the MyID Client Service will accept incoming connections.

    For information on access control and allowed access origins, see the Specifying the server for the MyID Client Service section in the MyID Operator Client guide.

• Exit – closes the MyID Client Service.